Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rewrite Performance API guide pages #25508

Merged
merged 13 commits into from
Apr 8, 2023
Merged

Rewrite Performance API guide pages #25508

merged 13 commits into from
Apr 8, 2023

Conversation

Elchi3
Copy link
Member

@Elchi3 Elchi3 commented Mar 21, 2023

Description

This PR rewrites the existing guide pages for the Performance API.

  • Previously, parts of the Performance API like User Timing, Resource Timing, Navigation Timing etc. were documented separately. This PR moves all guide material under Web/API/Performance_API/*.
  • The first guide is about Performance data and presents how to generally work with Performance data and what sorts of things can be measured.
  • The second guide is all about time and gives an overview how time works within the Performance API.
  • The following guides are about the individual parts of the Performance API, starting with Resource Timing, Navigation Timing and User Timing. There are more guides to be written here, but I wanted to take a break at this point.

Also, there are ideas about "How-to" and Tutorial pages, these will be written in a later PR, too.

Motivation

openwebdocs/project#62

Additional details

What sorts of review I'm looking for:

  • Is the overall structure good and should I continue to build upon it?
  • Review of the first 5 guides.

I know there are other Performance API guide pages in other trees on MDN, I would like to redirect/rework them in a follow-up PR. If you know of some pages somewhere, please send them to me.

Related issues and pull requests

None yet but I will create a PR against dom-examples to remove the entire folder of outdated example code https://github.com/mdn/dom-examples/tree/main/performance-apis

@Elchi3 Elchi3 requested review from a team as code owners March 21, 2023 13:15
@Elchi3 Elchi3 requested review from wbamberg, teoli2003 and bsmth and removed request for a team March 21, 2023 13:15
@github-actions github-actions bot added Content:Glossary Glossary entries Content:HTTP HTTP docs Content:WebAPI Web API docs labels Mar 21, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Mar 21, 2023 •
edited
Loading

Preview URLs (9 pages)
Flaws (2)

Note! 8 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/API/Performance_API/Performance_data
Title: Performance data
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/docs/Web/API/Performance_API/Element_timing
    • Can't resolve /en-US/docs/Web/API/Performance_API/Server_timing
External URLs (4)

URL: /en-US/docs/Web/API/Performance_API/High_precision_timing
Title: High precision timing

URL: /en-US/docs/Web/API/Performance_API/Navigation_timing
Title: Navigation timing

URL: /en-US/docs/Web/API/Performance_API/Resource_timing
Title: Resource timing

URL: /en-US/docs/Web/API/Performance_API/Performance_data
Title: Performance data

(comment last updated: 2023-04-07 12:05:50)

This was referenced Mar 21, 2023
Merged
Merged
wbamberg
wbamberg reviewed Apr 5, 2023
View reviewed changes
Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't finished, but I reviewed the first three guides. I think they are great in general!

Will review the other 2 tomorrow.

files/en-us/web/api/performance_api/performance_data/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performance_api/performance_data/index.md Show resolved Hide resolved
files/en-us/web/api/performance_api/performance_data/index.md Show resolved Hide resolved
files/en-us/web/api/performance_api/performance_data/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performance_api/performance_data/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performance_api/resource_timing/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performance_api/resource_timing/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performance_api/resource_timing/index.md Show resolved Hide resolved
files/en-us/web/api/performance_api/resource_timing/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performance_api/index.md Outdated Show resolved Hide resolved
wbamberg
wbamberg reviewed Apr 6, 2023
View reviewed changes
Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few more bits. Nice work!

files/en-us/web/api/performance_api/navigation_timing/index.md Show resolved Hide resolved
files/en-us/web/api/performance_api/navigation_timing/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performance_api/navigation_timing/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performance_api/navigation_timing/index.md Outdated Show resolved Hide resolved
files/en-us/web/api/performance_api/navigation_timing/index.md Outdated Show resolved Hide resolved
wbamberg
wbamberg approved these changes Apr 8, 2023
View reviewed changes
Copy link
Collaborator

@wbamberg wbamberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 looks great @Elchi3 !

@wbamberg wbamberg merged commit ecc3cef into mdn:main Apr 8, 2023
yin1999 added a commit to mdn/translated-content that referenced this pull request Apr 9, 2023
@yin1999
move Performance API guide pages
fe37b32 
ref: mdn/content#25508
yin1999 added a commit to mdn/translated-content that referenced this pull request Apr 9, 2023
@mdn-bot @yin1999
[zh-cn] sync translated content (#12636)
a403ea8 
* zh-cn: sync translated content

* move Performance API guide pages

ref: mdn/content#25508

---------

Co-authored-by: Allo <[email protected]>
@Elchi3 Elchi3 deleted the perf-guide branch April 10, 2023 08:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wbamberg wbamberg wbamberg approved these changes

@teoli2003 teoli2003 Awaiting requested review from teoli2003 teoli2003 is a code owner automatically assigned from mdn/yari-content-http

@bsmth bsmth Awaiting requested review from bsmth bsmth is a code owner automatically assigned from mdn/core-yari-content

Assignees
No one assigned
Labels
Content:Glossary Glossary entries Content:HTTP HTTP docs Content:WebAPI Web API docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Elchi3 @wbamberg